Documentation for class file_well

Inherits from 	control 

Properties declared in file_well 
	accepts_only_one_file 
	does_not_display_filename 
	double_click_action 
	double_click_target 
	drag_from_disabled 
	drag_to_disabled 
	file_extension_1 
	file_extension_2 
	file_extension_3 
	file_extension_4 
	slideback_disabled 

Class Methods declared in file_well 
	new 

Methods declared in file_well 
	any 
		accepts_only_one_file 
		does_not_display_filename 
		double_click_action 
		double_click_target 
		do_double_click_action 
		drag_from_disabled 
		drag_to_disabled 
		file 
		files 
		file_extension_1 
		file_extension_2 
		file_extension_3 
		file_extension_4 
		file_was_dragged 
		file_was_dropped 
		set_accepts_only_one_file(boolean) 
		set_does_not_display_filename(boolean) 
		set_double_click_action(message_name) 
		set_double_click_target(object) 
		set_drag_from_disabled(boolean) 
		set_drag_to_disabled(boolean) 
		set_files(string_collection) 
		set_file_extension_1(string) 
		set_file_extension_2(string) 
		set_file_extension_3(string) 
		set_file_extension_4(string) 
		set_slideback_disabled(boolean) 
		slideback_disabled 
	events 
		file_was_dragged 
		file_was_dropped 
	get 
		accepts_only_one_file 
		does_not_display_filename 
		double_click_action 
		double_click_target 
		drag_from_disabled 
		drag_to_disabled 
		file_extension_1 
		file_extension_2 
		file_extension_3 
		file_extension_4 
		slideback_disabled 
	set 
		set_accepts_only_one_file(boolean) 
		set_does_not_display_filename(boolean) 
		set_double_click_action(message_name) 
		set_double_click_target(object) 
		set_drag_from_disabled(boolean) 
		set_drag_to_disabled(boolean) 
		set_file_extension_1(string) 
		set_file_extension_2(string) 
		set_file_extension_3(string) 
		set_file_extension_4(string) 
		set_slideback_disabled(boolean) 

Class 
#begin_class
file_well 
The class file_well is a subclass of the class control. 
A file-well may accept files that are dragged over the screen for example from the Workspace.
A file-well can be set to only accept one file or files of a specific type.
When a file-well accepts a dragged file the file-well will get a black frame around itself.
When the file-well has accepted a file or a group of files the icon of the file(s) will be present in the file-well and may be dragged from the file-well.
#end_class

Properties 

#begin_property
accepts_only_one_file 
Stores a boolean value. If it is true the file-well will not accept groups of files that are dragged over it.
#end_property

#begin_property
does_not_display_filename 
Stores a boolean value. If it is true the file-well will not display the name of the file(s).
#end_property

#begin_property
double_click_action 
Stores the name of the action message that is used by the default implementation of the do_double_click_action method. The action message is sent to the object specified by the double_click_target property. 
#end_property

#begin_property
double_click_target 
Stores the reference to an object that receives the action message specified by the double_click_action property. When the file-well receives a do_double_click_action message it sends the action message to the target. 
#end_property

#begin_property
drag_from_disabled 
Stores a boolean value. If it is true you cannot drag files from the file-well. 
#end_property

#begin_property
drag_to_disabled 
Stores a boolean value. If it is true you cannot drag files to the file-well. 
#end_property

#begin_property
file_extension_1 
Stores an extension that specifies a filetype of files that the file-well accepts.
#end_property

#begin_property
file_extension_2 
Stores an extension that specifies a filetype of files that the file-well accepts.
#end_property

#begin_property
file_extension_3 
Stores an extension that specifies a filetype of files that the file-well accepts.
#end_property

#begin_property
file_extension_4 
Stores an extension that specifies a filetype of files that the file-well accepts.
#end_property

#begin_property
slideback_disabled 
Stores a boolean value. If it is true the "slide-back" animation that shows that the dragged file(s) was not accepted will be disabled.
#end_property

Methods 

#begin_method
accepts_only_one_file 
Returns the accepts_only_one_file property of the file-well.
#end_method

#begin_method
does_not_display_filename 
Returns the does_not_display_filename property of the file-well.
#end_method

#begin_method
double_click_action 
Returns the double_click_action property of the file-well.
#end_method

#begin_method
double_click_target 
Returns the double_click_target property of the file-well.
#end_method

#begin_method
do_double_click_action 
When the user double-clicks on the file-well the system sends a do_double_click_action message to the file-well. 
The default behavior of the do_double_click_action method in a file-well is to send the message stored in the double_click_action property to the object referenced by the double_click_target property.
Returns self.
Comment: Usually you just set the double_click_action and double_click_target properties to specify the behavior. 
You may override the default do_double_click_action behavior to get a specific behavior.
Note: If you want the double_click_action message to be sent to the double_click_target even when you override the do_double_click_action method, make sure the last line in your new do_double_click_action method is:
return super:do_double_click_action 
#end_method

#begin_method
drag_from_disabled 
Returns the drag_from_disabled property of the file-well.
#end_method

#begin_method
drag_to_disabled 
Returns the drag_to_disabled property of the file-well.
#end_method

#begin_method
file 
Returns the filename of the first file in the collection of files of the file-well.
#end_method

#begin_method
files 
Returns a collection of all the filenames of the file-well.
#end_method

#begin_method
file_extension_1 
Returns the file_extension_1 property of the file-well.
#end_method

#begin_method
file_extension_2 
Returns the file_extension_2 property of the file-well.
#end_method

#begin_method
file_extension_3 
Returns the file_extension_3 property of the file-well.
#end_method

#begin_method
file_extension_4 
Returns the file_extension_4 property of the file-well.
#end_method

#begin_method
file_was_dragged 
This method does not do anything. The message is sent to the file-well when the file(s) of the file-well is dragged from the file-well. Specialize the method to get the desired behavior. 
Returns self.
#end_method

#begin_method
file_was_dropped 
This method does not do anything. The message is sent to the file-well when one or more files are dropped on the file-well. Specialize the method to get the desired behavior. 
Returns self.
#end_method

#begin_method
set_accepts_only_one_file(boolean) 
Sets the accepts_only_one_file property to boolean.
Returns self.
#end_method

#begin_method
set_does_not_display_filename(boolean) 
Sets the does_not_display_filename property to boolean.
Returns self.
#end_method

#begin_method
set_double_click_action(message_name) 
Sets the double_click_action property to message_name.
Returns self.
#end_method

#begin_method
set_double_click_target(object) 
Sets the double_click_target property to object.
Returns self.
#end_method

#begin_method
set_drag_from_disabled(boolean) 
Sets the drag_from_disabled property to boolean.
Returns self.
#end_method

#begin_method
set_drag_to_disabled(boolean) 
Sets the drag_to_disabled property to boolean.
Returns self.
#end_method

#begin_method
set_files(string_collection) 
Sets the files of the file-well to the files in the collection string_collection. 
Returns self.
#end_method

#begin_method
set_file_extension_1(string) 
Sets the file_extension_1 property to string.
Returns self.
#end_method

#begin_method
set_file_extension_2(string) 
Sets the file_extension_2 property to string.
Returns self.
#end_method

#begin_method
set_file_extension_3(string) 
Sets the file_extension_3 property to string.
Returns self.
#end_method

#begin_method
set_file_extension_4(string) 
Sets the file_extension_4 property to string.
Returns self.
#end_method

#begin_method
set_slideback_disabled(boolean) 
Sets the slideback_disabled property to boolean.
Returns self.
#end_method

#begin_method
slideback_disabled 
Returns the slideback_disabled property of the file-well.
#end_method

Class Methods 

#begin_class_method
new 
Returns a new file-well object.
Ex:
{file_well}:new
#end_class_method